Tangoe Telecom SOAP API

22.1.x
(0 reviews)

> Split

getItemsForSplit()

The method returns all components for a given split described by a split ID. The result is a SplitItems object that contains one or multiple SplitItem objects. The structure of the used objects may be observed in the appendix section of this document. The format of the request and response messages is the following:

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:inv="http://www.asentinel.com/asentinelws/schemas/invord">
   <soapenv:Header/>
   <soapenv:Body>
      <inv:GetItemsForSplitRequest>
         <inv:splitID>?</inv:splitID>
      </inv:GetItemsForSplitRequest>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:inv="http://www.asentinel.com/asentinelws/schemas/invord">
   <soapenv:Header/>
   <soapenv:Body>
      <inv:GetItemsForSplitResponse>
         <!--Zero or more repetitions:-->
         <inv:splitItem>
            <!--Optional:-->
            <inv:costCenterId>?</inv:costCenterId>
            <inv:costCenterNo>?</inv:costCenterNo>
            <inv:percent>?</inv:percent>
            <!--Optional:-->
            <inv:amount>?</inv:amount>
         </inv:splitItem>
         <inv:result>
            <!--You may enter the following 2 items in any order-->
            <inv:code>?</inv:code>
            <!--Optional:-->
            <inv:message>?</inv:message>
         </inv:result>
      </inv:GetItemsForSplitResponse>
   </soapenv:Body>
</soapenv:Envelope>

Notes:

Errors:

  • Message validation error - SOAP fault message (see dedicated section for more details);
  • Data validation error – situations:
    • No split could be found for the provided split ID;
  • Operation error, if a database error occurs.

addSplit()

The method creates a new system split among several cost centers using the provided fields from SplitDetails object. The result of the operation is an object represented by a code and a message that provides details about the success of the operation. Also, the number of split components is returned as part of the response object. The split is not created:

  • if no split ID is provided, or
  • no cost centers (as split components) are provided, or
  • any of the provided cost centers (as split components) does not exist, or
  • the sum of the input percentages of the split components is not 100%.

The structure of the used objects may be observed in the appendix section of this document. The format of the request and response messages is the following:

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:inv="http://www.asentinel.com/asentinelws/schemas/invord">
   <soapenv:Header/>
   <soapenv:Body>
      <inv:AddSplitRequest>
         <inv:split>
            <!--You may enter the following 4 items in any order-->
            <!--Optional:-->
            <inv:splitID>?</inv:splitID>
            <!--Optional:-->
            <inv:splitName>?</inv:splitName>
            <!--Optional:-->
            <inv:splitItemsCount>?</inv:splitItemsCount>
            <!--Optional:-->
            <inv:splitItems>
               <!--Zero or more repetitions:-->
               <inv:splitItem>
                  <!--Optional:-->
                  <inv:costCenterId>?</inv:costCenterId>
                  <inv:costCenterNo>?</inv:costCenterNo>
                  <inv:percent>?</inv:percent>
                  <!--Optional:-->
                  <inv:amount>?</inv:amount>
               </inv:splitItem>
            </inv:splitItems>
         </inv:split>
      </inv:AddSplitRequest>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:inv="http://www.asentinel.com/asentinelws/schemas/invord">
   <soapenv:Header/>
   <soapenv:Body>
      <inv:AddSplitResponse>
         <!--Optional:-->
         <inv:splitID>?</inv:splitID>
         <inv:result>
            <!--You may enter the following 2 items in any order-->
            <inv:code>?</inv:code>
            <!--Optional:-->
            <inv:message>?</inv:message>
         </inv:result>
      </inv:AddSplitResponse>
   </soapenv:Body>
</soapenv:Envelope>

Notes:

  • Inside the provided splitDetails object, splitID must always be provided;
  • SplitItems inside splitDetails must contain valid cost centers;
  • The sum of the provided percentages of the splitItems inside splitDetails must be 100;

Errors:

  • Message validation error - SOAP fault message (see dedicated section for moredetails);
  • Data validation error – situations:
    • splitID is not provided (as it is considered compulsory);
    • at least one invalid costCenterNo was provided for a split item;
    • one of the particular fields contains invalid data;
  • Operation error, if a database error occurs.

editSplit()

The method updates an existing system split using the provided fields from SplitDetails object. The result of the operation is an object represented by a code and a message that provides details about the success of the operation. The split that is edited is identified based on the provided split ID inside SplitDetails object). There are two possible ways of updating a split:

  • Edit split name only – in case no cost centers are provided as split components; the existing ones remain as they were;
  • Edit split components – in case cost centers are provided as split components; the existing ones are replaced with the provided ones; the split name is ignored and the current ones remains.

The split is not updated:

  • if the provided split ID does not exist, or
  • any of the provided cost centers (as split components) does not exist, or
  • the sum of the input percentages of the split components is not 100%.

The structure of the used objects may be observed in the appendix section of this document. The format of the request and response messages is the following:

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:inv="http://www.asentinel.com/asentinelws/schemas/invord">
   <soapenv:Header/>
   <soapenv:Body>
      <inv:EditSplitRequest>
         <inv:split>
            <!--You may enter the following 4 items in any order-->
            <!--Optional:-->
            <inv:splitID>?</inv:splitID>
            <!--Optional:-->
            <inv:splitName>?</inv:splitName>
            <!--Optional:-->
            <inv:splitItemsCount>?</inv:splitItemsCount>
            <!--Optional:-->
            <inv:splitItems>
               <!--Zero or more repetitions:-->
               <inv:splitItem>
                  <!--Optional:-->
                  <inv:costCenterId>?</inv:costCenterId>
                  <inv:costCenterNo>?</inv:costCenterNo>
                  <inv:percent>?</inv:percent>
                  <!--Optional:-->
                  <inv:amount>?</inv:amount>
               </inv:splitItem>
            </inv:splitItems>
         </inv:split>
      </inv:EditSplitRequest>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:inv="http://www.asentinel.com/asentinelws/schemas/invord">
   <soapenv:Header/>
   <soapenv:Body>
      <inv:EditSplitResponse>
         <inv:result>
            <!--You may enter the following 2 items in any order-->
            <inv:code>?</inv:code>
            <!--Optional:-->
            <inv:message>?</inv:message>
         </inv:result>
      </inv:EditSplitResponse>
   </soapenv:Body>
</soapenv:Envelope>

Notes:

  • The split that is updated is determined based on the provided splitID inside the splitDetails object;
  • splitID inside splitDetails is not editable;
  • splitItems inside splitDetails must contain at least one valid cost center;
  • the sum of the provided percentages of the splitItems inside splitDetails must be 100;

Errors:

  • Message validation error - SOAP fault message (see dedicated section for more details);
  • Data validation error – situations:
    • splitID is not provided (as it is considered compulsory);
    • at least one invalid costCenterNo was provided for a split item;
    • one of the particular fields contains invalid data;
  • Operation error, if a database error occurs.

findSplit()

The method queries the database for system splits based on the provided splitID and splitName. Together with the filter, a maximum number of returned items may be included in the request. If this is not present, all found records are returned from the database. The result of the operation is a list with zero or more system splits that match the provided filter and an object represented by a code and a message with details about the success of the operation. The structure of the used objects may be observed in appendix section of this document. The format of the request and response messages is the following:

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:inv="http://www.asentinel.com/asentinelws/schemas/invord">
   <soapenv:Header/>
   <soapenv:Body>
      <inv:FindSplitRequest>
         <inv:split>
            <!--You may enter the following 4 items in any order-->
            <!--Optional:-->
            <inv:splitID>?</inv:splitID>
            <!--Optional:-->
            <inv:splitName>?</inv:splitName>
            <!--Optional:-->
            <inv:splitItemsCount>?</inv:splitItemsCount>
            <!--Optional:-->
            <inv:splitItems>
               <!--Zero or more repetitions:-->
               <inv:splitItem>
                  <!--Optional:-->
                  <inv:costCenterId>?</inv:costCenterId>
                  <inv:costCenterNo>?</inv:costCenterNo>
                  <inv:percent>?</inv:percent>
                  <!--Optional:-->
                  <inv:amount>?</inv:amount>
               </inv:splitItem>
            </inv:splitItems>
         </inv:split>
         <!--Optional:-->
         <inv:maxNoOfRecords>?</inv:maxNoOfRecords>
      </inv:FindSplitRequest>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:inv="http://www.asentinel.com/asentinelws/schemas/invord">
   <soapenv:Header/>
   <soapenv:Body>
      <inv:FindSplitResponse>
         <!--Zero or more repetitions:-->
         <inv:split>
            <!--You may enter the following 4 items in any order-->
            <!--Optional:-->
            <inv:splitID>?</inv:splitID>
            <!--Optional:-->
            <inv:splitName>?</inv:splitName>
            <!--Optional:-->
            <inv:splitItemsCount>?</inv:splitItemsCount>
            <!--Optional:-->
            <inv:splitItems>
               <!--Zero or more repetitions:-->
               <inv:splitItem>
                  <!--Optional:-->
                  <inv:costCenterId>?</inv:costCenterId>
                  <inv:costCenterNo>?</inv:costCenterNo>
                  <inv:percent>?</inv:percent>
                  <!--Optional:-->
                  <inv:amount>?</inv:amount>
               </inv:splitItem>
            </inv:splitItems>
         </inv:split>
         <inv:result>
            <!--You may enter the following 2 items in any order-->
            <inv:code>?</inv:code>
            <!--Optional:-->
            <inv:message>?</inv:message>
         </inv:result>
      </inv:FindSplitResponse>
   </soapenv:Body>
</soapenv:Envelope>

Notes:

Errors:

  • Message validation error - SOAP fault message (see dedicated section for more details);
  • Operation error, if a database error occurs.

Reviews